/* NOTICE
    OpenJaWS - Open Java Weather Station
    
    Copyright (C) 2008 Grant Gardner <grant@lastweekend.com.au>
    
    OpenJaWS is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
    
NOTICE */

package au.com.lastweekend.openjaws.api;

import java.io.Serializable;
import java.util.Date;

import au.com.lastweekend.openjaws.units.Unit;

/**
 * Structure wrapping a unit value with time.
 * 
 * @author ggardner
 * 
 */
public class RecordedValue implements Serializable {

    private Date time;
    private UnitValue unitValue;

    public static final RecordedValue NULL = new RecordedValue(null, UnitValue.NULL);

    public RecordedValue(Date time, double value, Unit unit) {

        this(time, new UnitValue(value, unit));
    }

    public RecordedValue(Date time, UnitValue unitValue) {

        this.time = time;
        this.unitValue = unitValue;
    }

    public Date getTime() {

        return time;
    }

    public UnitValue getUnitValue() {

        return unitValue;
    }

    public String toString() {

        // We don't know the subclass of Unit value so we can't guess a format
        return format("%s @ %tc");

    }

    /**
     * 
     * @param formatSpec
     *            expects a placeholder for each of unitValue and time
     * @return the formatted value
     */
    public String format(String formatSpec) {

        return String.format(formatSpec, unitValue, time);
    }

    @Override
    public int hashCode() {

        final int prime = 31;
        int result = 1;
        result = prime * result + ((time == null) ? 0 : time.hashCode());
        result = prime * result + ((unitValue == null) ? 0 : unitValue.hashCode());
        return result;
    }

    @Override
    public boolean equals(Object obj) {

        if (this == obj)
            return true;
        if (obj == null)
            return false;
        if (getClass() != obj.getClass())
            return false;
        final RecordedValue other = (RecordedValue) obj;
        if (time == null) {
            if (other.time != null)
                return false;
        } else if (!time.equals(other.time))
            return false;
        if (unitValue == null) {
            if (other.unitValue != null)
                return false;
        } else if (!unitValue.equals(other.unitValue))
            return false;
        return true;
    }

}